build-docs: Add option to disable doxygen/sphinx docs #66928
Conversation
Doxygen documentation takes very long to build, when making releases we want to get the normal documentation up earlier so that we don't have to wait for doxygen documentation. This PR just adds the flag to disable doxygen builds, I will then later make a PR that changes the actions to first build the normal docs and another job to build the doxygen docs.
tru
changed the title
llvm/utils/release/build-docs.sh
Outdated
| if [ "$no_sphinx" != "yes" ]; then | ||
| sphinx_targets="docs-clang-html docs-clang-tools-html docs-flang-html docs-lld-html docs-llvm-html docs-polly-html" | ||
| sphinx_flag=" -DLLVM_ENABLE_SPHINX=ON -DSPHINX_WARNINGS_AS_ERRORS=OFF" | ||
| fi | ||
|
|
||
| if [ "$no_doxygen" != "yes" ]; then | ||
| echo "Doxygen: enabled" | ||
| doxygen_targets="$docs_target doxygen-clang doxygen-clang-tools doxygen-flang doxygen-llvm doxygen-mlir doxygen-polly" | ||
| doxygen_flag=" -DLLVM_ENABLE_DOXYGEN=ON -DLLVM_DOXYGEN_SVG=ON" | ||
| else | ||
| echo "Doxygen: disabled" | ||
| fi |
There was a problem hiding this comment.
Why do you print a message for doxygen and not sphinx? I think we should be consistent here
There was a problem hiding this comment.
Good point! I added the -no-sphinx option later and just forgot. I will fix so that it always writes status for both.
Maybe the doxygen build should be a nightly job? |
Yes maybe. But I want to make sure that we build doxygen docs for the release tag. I just need to separate it out, waiting for the job to finish (and sometimes fail!) makes releasing a new version very frustrating. |
Doxygen documentation takes very long to build, when making releases we
want to get the normal documentation up earlier so that we don't have to
wait for doxygen documentation.
This PR just adds the flag to disable doxygen builds, I will then later
make a PR that changes the actions to first build the normal docs and
another job to build the doxygen docs.